docs: restructure into docs/<skill-family>/, slim README to install + overview#36
Merged
Merged
Conversation
… family overview
The top-level README is reshaped to be the framework's adoption
entry point — overview + 3-family table + 3-step bootstrap + the
submodule-update reminder + cross-references, in 113 lines. All
detailed content moves into a new docs/ tree split by skill family,
so adopters can read only the family they care about.
Layout
/
├── README.md (slim — 113 lines)
├── AGENTS.md, CONTRIBUTING.md, NOTICE, LICENSE (unchanged at root)
└── docs/
├── prerequisites.md (general prereqs — Claude Code,
│ Gmail MCP, GitHub auth, etc.)
├── setup/
│ ├── README.md (skill-family overview + link map)
│ ├── secure-agent-setup.md (moved from root)
│ └── secure-agent-internals.md (moved from root)
├── security/
│ ├── README.md (skill-family overview + link map)
│ ├── process.md (16-step lifecycle + Mermaid +
│ │ label lifecycle — extracted from
│ │ README's Process reference section)
│ ├── roles.md (Who-this-guide-is-for + Shared
│ │ conventions + role guides for
│ │ issue triager / remediation
│ │ developer / release manager —
│ │ extracted from README)
│ ├── how-to-fix-a-security-issue.md (moved from root)
│ └── new-members-onboarding.md (moved from root)
└── pr-management/
└── README.md (skill-family overview + adopter
contract pointer)
What stays in the README
- Project overview (1 paragraph)
- Skill-family table (the three families: setup, security, pr-management)
- 3-step adopter bootstrap (git submodule add + cp -r _template/ +
ln -s .claude/skills/)
- Keeping the submodule current (post-merge hook)
- Cross-reference pointers (prerequisites, AGENTS.md, CONTRIBUTING.md,
projects/_template/)
What moved out
- Process reference (16 steps + Mermaid) → docs/security/process.md
- Label lifecycle → docs/security/process.md
- Role guides (For triager / dev / RM) → docs/security/roles.md
- Who this guide is for + Shared conventions → docs/security/roles.md
- Prerequisites for running the agent skills → docs/prerequisites.md
- secure-agent-setup.md (root) → docs/setup/
- secure-agent-internals.md (root) → docs/setup/
- how-to-fix-a-security-issue.md (root) → docs/security/
- new-members-onboarding.md (root) → docs/security/
Cross-references updated everywhere — links from non-moved files
to the moved ones now use the new path; links inside the moved
files to root-level files (README, AGENTS.md, .claude/skills/,
tools/, projects/) gain the `../../` prefix.
doctoc TOCs regenerated. All pre-commit hooks pass.
Generated-by: Claude Code (Claude Opus 4.7)
6 tasks
andreahlert
added
the
mode:platform
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reshape the top-level README into the framework's adoption entry point — overview + 3-family table + 3-step bootstrap + submodule-update reminder, in 113 lines (was 1110). All detailed content moves into a new
docs/tree split by skill family so adopters can read only the family they care about.New layout
What stays in the README
git submodule add+cp -r _template/+ln -s .claude/skills/)What moved out
docs/security/process.mddocs/security/process.mddocs/security/roles.mddocs/security/roles.mddocs/prerequisites.mdsecure-agent-setup.mddocs/setup/secure-agent-internals.mddocs/setup/how-to-fix-a-security-issue.mddocs/security/new-members-onboarding.mddocs/security/Cross-references
Updated everywhere — links from non-moved files to the moved ones now use the new path; links inside the moved files to root-level files (
README.md,AGENTS.md,.claude/skills/,tools/,projects/) gain the../../prefix. doctoc TOCs regenerated for every changed.md.Test plan
process.mdare reachable fromroles.md(the(#step-N)refs in roles.md were rewritten to(process.md#step-N))docs/<family>/docs/<family>/README.mdfor accuracy🤖 Generated with Claude Code